adTempus API
PreviousUpNext
INotificationOptions::TestBackup Method

Sends a test message using the backup server.

C++
HRESULT TestBackup(BSTR sendTo, [out,retval] IADError** result);
C#
TestBackup(String sendTo, [out,retval] IADError* result);
Visual Basic
Sub TestBackup(sendTo As String, result As [out,retval] IADError*)
Parameters 
Description 
[in] BSTR sendTo 
The SMTP e-mail address to send the test message to. 
[out,retval] IADError** result 
The return value. 

An ADError object whose message describes the result of the test.

This method uses the "uncommitted" changes to the NotificationOptions. That is, you can test your new settings using this method without saving them to the server first. 

The returned error object will have a severity of adetSuccess if the message was sent successfully or adetError if it was not.

adTempus API Reference version 3.0.0.0, revised 10/30/2008